Add Schedules for User Log Purging

The schedules are classified as task and sub-task, where the parent tasks are referred as Schedule and the child tasks as Sub-tasks. If a task or sub-task fails, then the status of both the task and sub-task are updated with Failed status in the User Log Purge table; the Rerun button is enabled and the schedules for this task and sub-tasks is set as Immediate purge. If the main task has a failed sub-task under it, then the status of the main task is updated with Failed status. The next task is created only when the current task is completed, so the future task is not created and there will be no scenario where the future task is classified under 'Error' status until the current task with error is processed.

For example the difference of task and sub tasks is the user sets a 'Monthly' schedule for 5 years, the system will create a Schedule (Parent Task) for the entire tenure of the Purge Schedule with Start Date to End Date, and the corresponding sub-task for each month will be created on the month when they are to be executed.

Start Date = 01-Jan-2019

End Date = 31-Dec-2024

Schedule = Monthly (1st every month)

Sub-task created every month will be 01-Jan-2019, 01-Feb-2019, 01-Mar-201, and so on until 01-Dec-2024.

Types of User Logs Purging

The OIPA - Admin console supports different user logs purging:

  • Immediate Purge: The purging is done in the same session
  • Scheduled Purge: The purging is done automatically by scheduling a job
  • Adhoc Purge: The purging is done on a selected calendar date

Steps for Immediate Purge

The immediate purge option allows to purge logs in the same session, the following steps explains how to set immediate purging:

  1. In the Log Purge tab, click + Add Schedule.
  2. Select Immediate option, under the Schedule Type section.
  3. In the Search Criteria section select one of the below option and click Next,
    • Select a date in Log Creation Older Than date field in the "MM/DD/YYYY" format.
    • Enter a number in User Logs Older than Tenure text box for the Month / Year drop-down list option. The number limit for months 0-240 and for years is 0-20.
  4. Enter the reason for purging the data in the Notes text box and click Next.
  5. The Statistics tab displays the details of the purge in the Details tab.
  6. Click OK. A warning message is displayed for final confirmation. If you click OK, the Immediate purge is initiated and after the process is complete the status is updated in the User Log Purge table.

Note: This final confirmation deletes all the logs, and cannot be retrieved. When the immediate purge is in progress, the system displays "Purge in progress" message and will only show the purge details once the purge process is complete.

Steps for Adhoc Purge

The Adhoc purge allows you to purge user logs for future purge for a selected calendar date. To set Adhoc purge, perform the following:

  1. In the Log Purge tab, click + Add Schedule.
  2. Select Schedule option, under the Schedule Type section.
  3. In the Search Criteria section select a date in Log Creation Older Than date field and click Next,
  4. Select the date and time in the Start date and Schedule Time.
  5. Enter notes in the Notes text box .
  6. The Statistics tab displays the details of the Adhoc purge in the Details tab. Click OK. A warning message is displayed for final confirmation. If you click OK, the Adhoc purge is initiated and the status is updated in User Log Purge table.

Steps for Schedule Purge

The Schedule purge allows you to purge user logs for future purge cycles by configuring scheduled jobs. To set Schedule purge, perform the following:

  1. In the Log Purge tab, click + Add Schedule.
  2. Select Schedule option, under the Schedule Type section.
  3. Enter a number in the User Logs Older than Tenure text box for the Month / Year drop-down list option. The number limit for months 0-240 and for years is 0-20.
  4. Click Next the Scheduler tab appears.
  5. Select a date in the Start Date option and time in the Schedule Time.
    • If you select Monthly from the Frequency drop-down list, enter the Tenure / End By/ Until and then enter a number value in the Recur Every (Monthly) text box.
    • If you select Quarterly / Biannual / Annual from the Frequency drop-down list then select the Tenure / End By/ Until and enter a number value in the Recur Every ( Quarterly / Biannually / Annually) text box.
  6. Enter notes in the Notes text box and click Next.
  7. The Statistics tab displays the details of the Schedule purge in the Details tab. Click OK. A warning message is displayed for final confirmation. If you click OK, the Schedule purge is initiated and the status is updated in User Log Purge table.